AddressValidation

This XML API is used to do the address validation in Melissa database

End Point https://www.vcareapi.com/vcareOssApi/AddressValidation/
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 Auto generated unique reference number is required to be passed with each transaction.
ENROLLMENTID string 123456 Required Auto generatednumber this is returned in Getcustomerinfo Alphanumeric
FIRSTNAME string John Required This is the first name of the applicant. Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
MIDDLENAME string A Optional This is the middle name of the applicant. Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
LASTNAME string Doe Required This is the last name of the applicant. Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
ADDRESS TYPE string 123456 Optional Defailt value SERVICE Should be SERVICE OR MAILING
ADDRESS1 string 123 Main St Required This is the service address line 1 of the applicant. Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
ADDRESS2 string Apt 1 Optional This is the service address line 2 of the applicant. Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
CITY string Houston Required This is the service address city of the applicant. Should allow only letters, hyphen and space.
STATE string TX Required This is the service address state of the applicant. State should be standard abbreviated form.
ZIPCODE string 73001 Required This is the service address zipcode of the applicant. Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
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.
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>Vcarecorporation</VENDORID>
	<USERNAME>Vcarecorporation</USERNAME>
	<PASSWORD>Vcarecorporation</PASSWORD>
	<PIN>Vcarecorporation</PIN>
	<REFERENCENUMBER>11111</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
<ADDRESSVALIDATION>
	<ENROLLMENTID></ENROLLMENTID>
	<FIRSTNAME></FIRSTNAME>
	<MIDDLENAME></MIDDLENAME>
	<LASTNAME></LASTNAME>
	<ADDRESS_TYPE></ADDRESS_TYPE>
	<SERVICE_ADDRESS1>T</SERVICE_ADDRESS1>
	<SERVICE_ADDRESS2></SERVICE_ADDRESS2>
	<CITY></CITY>
	<STATE></STATE>
	<ZIPCODE></ZIPCODE>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</ADDRESSVALIDATION>
</VCAREOSS>
</VCAREOSSAPI>
List of status code, description and resolution.
Status Code Description How to Resolve?
00 SUCCESS SUCCESS
01 Error Received from Carrier. Please try again with valid data.
13 Password is invalid. Provide a valid Password.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
73 Invalid First Name. Please provide valid First Name.
74 Invalid Last Name. Please provide valid Last Name.
113 Zip Code is required. Zip code cannot be blank. You should enter a valid Zip code.
116 City is required. City cannot be blank. You should enter a valid City.
118 State is required. State cannot be blank. You should enter a valid State.
122 Invalid Format in Billing Address2. Please provide a valid Format in Billing Address2.
132 Service Address1 is required. Service address 1 cannot be blank. You should enter a valid service address 1.
230 Address is unconfirmed from Melissa. Please provide a different address which can be unconfirmed from Melissa.
281 First Name should not be blank. Please provide First Name as its mandatory.
282 First Name should greater than 2 characters. Please provide more than 2 characters in First Name.
283 Last Name should not be blank. Please provide Last Name as its mandatory.
284 Last Name should greater than 2 characters. Please provide more than 2 characters in Last Name.
285 Invalid Service Address1. Please provide a valid Service Address1.
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>1111111</referenceNumber>
</credentials>
<AddressValidation>
<statusCode>00</statusCode>
	<description>SUCCESS</description><errorDescription>SUCCESS</errorDescription>
	<melissareturnaddress>807 S BROADWAY AVE SHAWNEE OK 74801</melissareturnaddress>
	<service_address_one>807 S BROADWAY AVE</service_address_one>
	<service_address_two></service_address_two>
	<city>SHAWNEE</city>
	<state>OK</state>
	<zipcode>74801</zipcode>
	<address_status>CONFIRMED</address_status>
	<messageas16></messageas16>
	<messageas17></messageas17>
	<messageas></messageas>
</AddressValidation>
</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>
<AddressValidation>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Error Received from Carrier.
How to Resolve?: Please try again with valid data.
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>
<AddressValidation>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Password is invalid.
How to Resolve?: Provide a valid Password.
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>
<AddressValidation>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
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>
<AddressValidation>
	<statusCode>73</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid First Name.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Invalid First Name.
How to Resolve?: Please provide valid First Name.
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>
<AddressValidation>
	<statusCode>74</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Last Name.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Invalid Last Name.
How to Resolve?: Please provide valid Last Name.
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>
<AddressValidation>
	<statusCode>113</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip Code is required.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Zip Code is required.
How to Resolve?: Zip code cannot be blank. You should enter a valid Zip code.
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>
<AddressValidation>
	<statusCode>116</statusCode>
	<description>FAIL</description>
	<errorDescription>City is required.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: City is required.
How to Resolve?: City cannot be blank. You should enter a valid City.
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>
<AddressValidation>
	<statusCode>118</statusCode>
	<description>FAIL</description>
	<errorDescription>State is required.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: State is required.
How to Resolve?: State cannot be blank. You should enter a valid State.
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>
<AddressValidation>
	<statusCode>122</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Format in Billing Address2.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Invalid Format in Billing Address2.
How to Resolve?: Please provide a valid Format in Billing Address2.
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>
<AddressValidation>
	<statusCode>132</statusCode>
	<description>FAIL</description>
	<errorDescription>Service Address1 is required.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Service Address1 is required.
How to Resolve?: Service address 1 cannot be blank. You should enter a valid service address 1.
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>
<AddressValidation>
	<statusCode>230</statusCode>
	<description>FAIL</description>
	<errorDescription>Address is unconfirmed from Melissa.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Address is unconfirmed from Melissa.
How to Resolve?: Please provide a different address which can be unconfirmed from Melissa.
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>
<AddressValidation>
	<statusCode>281</statusCode>
	<description>FAIL</description>
	<errorDescription>First Name should not be blank.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: First Name should not be blank.
How to Resolve?: Please provide First Name as its mandatory.
Sample Fail Response: 13
<?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>
<AddressValidation>
	<statusCode>282</statusCode>
	<description>FAIL</description>
	<errorDescription>First Name should greater than 2 characters.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: First Name should greater than 2 characters.
How to Resolve?: Please provide more than 2 characters in First Name.
Sample Fail Response: 14
<?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>
<AddressValidation>
	<statusCode>283</statusCode>
	<description>FAIL</description>
	<errorDescription>Last Name should not be blank.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Last Name should not be blank.
How to Resolve?: Please provide Last Name as its mandatory.
Sample Fail Response: 15
<?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>
<AddressValidation>
	<statusCode>284</statusCode>
	<description>FAIL</description>
	<errorDescription>Last Name should greater than 2 characters.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Last Name should greater than 2 characters.
How to Resolve?: Please provide more than 2 characters in Last Name.
Sample Fail Response: 16
<?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>
<AddressValidation>
	<statusCode>285</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Service Address1.</errorDescription>
</AddressValidation>
</VcareOssApi>
Error Description: Invalid Service Address1.
How to Resolve?: Please provide a valid Service Address1.

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