UpdateCustomerInfo

This XML API is used to update the carrier of the ESN/SIM in the inventory

End Point https://www.vcareapi.com/vcareOssApi/UpdateCustomerInfo/
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.
REFERENCENUMBER string 123456789 Required Auto generated unique reference number is required to be passed with each transaction.
CUSTOMERID Numeric 123456 Required Auto generated customer account number. This is returned in GetCustomerInfo.
FIRST NAME String John Optional This is the first name of the customer. OnlyEnglish alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name the space should be cut off. when Account Type NL
MIDDLE NAME String Optional This is the last name of the customer. OnlyEnglish alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name the space should be cut off.when Account Type NL
LAST NAME String Optional This is the last name of the customer. OnlyEnglish alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name the space should be cut off. when Account Type NL
BIRTH DATE string 1985-12-01 Optional This is the date of birth of the applicant. YYYY-MM-DD is expected. hyphen allowed.
SOCIAL SECURITY NUMBER Numeric 1234 Optional This is the social security number of the applicant. You may pass 4 or 9 digits based on the state requirement configured in Telgoo5. No hyphen allowed
ACCOUNT PASSWORD String Optional This is the account Password of the customer.
ALTERNATE PHONE String Optional This is the account Password of the customer.
SECURITY QUESTION String Optional This is the security question of the customer.
SECURITY QUESTION ANSWER String Optional This is the security question of the customer.
EMAIL String Optional This is the email of the customer.
AUTHORIZED USER String Optional This is the authorized user of the customer.
AUTHORIZED PASSWORD String Optional This is the authorized password of the customer.
AUTHORIZED QUESTION String Optional This is the authorized question of the customer.
AUTHORIZED ANSWER String Optional This is the authorized answer of the customer.
AGENTID string John Doe Required This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.  
AGENTPASSWORD 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 Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
Sample Request 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></VENDORID>
 <USERNAME></USERNAME>
 <PASSWORD></PASSWORD>
 <PIN></PIN>
 <REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
 <UPDATECUSTOMERINFO>
   <CUSTUMERID></CUSTUMERID>
   <FIRSTNAME></FIRSTNAME>
   <MIDDLENAME></MIDDLENAME>
   <LASTNAME></LASTNAME>
   <DOB></DOB>
   <SSN></SSN>
   <ACCOUNTPASSWORD></ACCOUNTPASSWORD>
   <ALTERNATEPN></ALTERNATEPN>
   <SECURITYQUESTION></SECURITYQUESTION>
   <SECURITYQUESTIONANSWER></SECURITYQUESTIONANSWER>
   <EMAIL></EMAIL>
   <AUTHORIZEDUSER></AUTHORIZEDUSER>
   <AUTHORIZEDPASSWORD></AUTHORIZEDPASSWORD>
   <AUTHORIZEDQUESTION></AUTHORIZEDQUESTION>
   <AUTHORIZEDANSWER></AUTHORIZEDANSWER>
   <AGENTID></AGENTID>
   <AGENTPASSWORD></AGENTPASSWORD>
   <SOURCE>TABLET</SOURCE>
 </UPDATECUSTOMERINFO>
</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.
25 Customer ID is invalid. Provide a valid Customer ID.
43 Multiple input errors. Please check description. This is providing multiple dynamic errors.
44 Input error. Please check description. This is provided dynamic error.
226 Customer ID is required. Please provide Customer ID.
241 Invalid Email address. Please provide a valid Email address.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
721 Question is invalid. Please provide a valid Question. Given value is invalid for Question.
722 Authorized question is invalid. Please provide a valid Authorized question. Given value is invalid for Authorized question.
751 Custom message. This is dynamic message.
Sample Response
<?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>11111111</referenceNumber>
    </credentials>
    <UpdateCustomerInfo>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
    </UpdateCustomerInfo>
</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>
<UpdateCustomerInfo>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</UpdateCustomerInfo>
</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>
<UpdateCustomerInfo>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</UpdateCustomerInfo>
</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>
<UpdateCustomerInfo>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Customer ID is invalid.
How to Resolve?: Provide a valid Customer 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>
<UpdateCustomerInfo>
	<statusCode>43</statusCode>
	<description>FAIL</description>
	<errorDescription>Multiple input errors.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Multiple input errors.
How to Resolve?: Please check description. This is providing multiple dynamic errors.
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>
<UpdateCustomerInfo>
	<statusCode>44</statusCode>
	<description>FAIL</description>
	<errorDescription>Input error.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Input error.
How to Resolve?: Please check description. This is provided dynamic error.
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>
<UpdateCustomerInfo>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Customer ID is required.
How to Resolve?: Please provide Customer ID.
Sample Fail Response: 7
<?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>
<UpdateCustomerInfo>
	<statusCode>241</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Email address.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Invalid Email address.
How to Resolve?: Please provide a valid Email address.
Sample Fail Response: 8
<?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>
<UpdateCustomerInfo>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
Sample Fail Response: 9
<?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>
<UpdateCustomerInfo>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
Sample Fail Response: 10
<?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>
<UpdateCustomerInfo>
	<statusCode>721</statusCode>
	<description>FAIL</description>
	<errorDescription>Question is invalid.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Question is invalid.
How to Resolve?: Please provide a valid Question. Given value is invalid for Question.
Sample Fail Response: 11
<?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>
<UpdateCustomerInfo>
	<statusCode>722</statusCode>
	<description>FAIL</description>
	<errorDescription>Authorized question is invalid.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Authorized question is invalid.
How to Resolve?: Please provide a valid Authorized question. Given value is invalid for Authorized question.
Sample Fail Response: 12
<?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>
<UpdateCustomerInfo>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</UpdateCustomerInfo>
</VcareOssApi>
Error Description: Custom message.
How to Resolve?: This is dynamic message.

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