Duplicate Check

This XML API checks if the applicant who is applying for the lifeline services is duplicate in your database with any other active subscribers in your database or not. There are several checks and algorithms by which we determine the duplicate subscriber. Below is the duplicate check process.

  • First & last name, Address line 1 and Zip code.
  • First & Last name, last 4 of SSN & DOB
  • Last name, last four of SSN & DOB
  • First name, last four of SSN & DOB
  • First Name, DOB and Address.
  • Last Name, DOB and Address.
  • Beneficiary First & last name, Address line 1 and Zip code.
  • Beneficiary First & Last name, last 4 of SSN & DOB
  • Beneficiary Last name, last four of SSN & DOB
  • Beneficiary First name, last four of SSN & DOB
  • Beneficiary First Name, DOB and Address.
  • Beneficiary Last Name, DOB and Address.

Exact DL duplicate Number

End Point https://www.vcareapi.com/vcareOssApi/DuplicateCheck/
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.
ENROLLMENT ID string AN12345 Optional 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
FIRSTNAME string John Required Applicant's first name.
LASTNAME string Doe Required Applicant's last name.
ADDRESS1 string 123 Main St Required Address line 1 for the Service address of the applicant.
ADDRESS2 string Houston Optional Address line 2 for the Service address of the applicant.
CITY string Houston Required City for the service address. Should allow only letters, hyphen and space.
STATE string TX Required State for the service address. State should be standard abbreviated form.
ZIPCODE string 73001 Required This is the zip code for the service address of the customer. Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
BIRTHDATE string John Doe Required Date of Birth of the applicant. Date format should be YYYY-MM-DD
Last four digits of SSN Numeric 1234 Required Last four digits of the social security number of the applicant. Only four digits are allowed.
DRIVER'S LICENCE NUMBER string sadg456464g Conditional This is the driving license number of the subscriber. This is a config field, if the configuration is ON for the MVNO for this field then it will be required field. Alphanumeric
BENEFICIARY FIRST NAME string John Conditional if qualifying beneficiary same as customer then Y then required. This is the first name of the qualifying beneficiary 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.
BENEFICIARY LAST NAME string Doe Conditional if qualifying beneficiary same as customer then Y is required. This is the last name of the qualifying beneficiary. 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.
BENEFICIARY BIRTHDATE string 1985-12-01 Conditional if qualifying beneficiary same as customer then Y is required. This is the date of birth of the applicant. YYYY-MM-DD is expected.
BENEFICIARY SOCIAL SECURITY NUMBER Numeric 1234 Conditional if qualifying beneficiary same as customer then Y is required. This is the social security number of the beneficiary. You may pass 4 or 9 digits based on the state requirement configured in Telgoo5. No hyphen allowed. beneficiary SSN/Tribal ID is required.
SERVICE TYPE string LIFELINE, ACP and COMBO Required This determines the type of service type. Service type should be LIFELINE,ACP and COMBO. Default value LIFELINE
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="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>
<DUPLICATECHECK>
	<ENROLLMENTID></ENROLLMENTID>
	<FIRSTNAME></FIRSTNAME>
	<LASTNAME></LASTNAME>
	<ADDRESS1></ADDRESS1>
	<ADDRESS2></ADDRESS2>
	<CITY></CITY>
	<STATE></STATE>
	<ZIP></ZIP>
	<BIRTHDATE></BIRTHDATE>
	<SSN></SSN>
	<DRIVERSLICENCENUMBER></DRIVERSLICENCENUMBER>
	<BENEFICIARYFIRSTNAME></BENEFICIARYFIRSTNAME>
	<BENEFICIARYLASTNAME></BENEFICIARYLASTNAME>
	<BENEFICIARYDOB></BENEFICIARYDOB>
	<BENEFICIARYSSN></BENEFICIARYSSN>
	<SERVICETYPE></SERVICETYPE>
	<SOURCE></SOURCE>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
</DUPLICATECHECK>
</VCAREOSS>
</VCAREOSSAPI>
List of status code, description and resolution.
Status Code Description How to Resolve?
00 SUCCESS SUCCESS
10 You cannot enroll with this resident address because it has the maximum number of allowable households with active Lifeline service. You are exceeding max number of lifeline enrollemt for this resident address.
13 Password is invalid. Provide a valid Password.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
43 Multiple input errors. Please check description. This is providing multiple dynamic errors.
44 Input error. Please check description. This is provided dynamic error.
46 Internal duplicate. Provide another data.
47 H2O is down. H2O is down. Please try again later.
49 H2O Duplicate. H2O is a duplicate value.
50 HOUSEHOLD::Household in H2O. Duplicate address is coming in H2O.
56 Internal duplicate checking API is down. Please try again later. Internal duplicate checking API is down. Please try again later.
66 Invalid date format. Please provide date in defined format.
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.
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></referenceNumber>
    </credentials>
    <DuplicateCheck>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>Internal duplicate.: DUPLICATE</errorDescription>
        <duplicatestatus>DUPLICATE</duplicatestatus>
    </DuplicateCheck>
</VcareOssApi>

SUCCESS

List of all the status codes will be shared separately.

<duplicatestatus>DUPLICATE means that the subscriber is exact duplicate in the system. If it is HOUSEHOLD then it means only the address is duplicate and you will need to pass the IEH flag in createcustomer API to override Household duplicate

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>
	<DuplicateCheck>
	<statusCode>10</statusCode>
	<description>FAIL</description>
	<errorDescription>You cannot enroll with this resident address because it has the maximum number of allowable households with active Lifeline service.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: You cannot enroll with this resident address because it has the maximum number of allowable households with active Lifeline service.
How to Resolve?: You are exceeding max number of lifeline enrollemt for this resident address.
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>
	<DuplicateCheck>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</DuplicateCheck>
</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>
	<DuplicateCheck>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</DuplicateCheck>
</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>
	<DuplicateCheck>
	<statusCode>43</statusCode>
	<description>FAIL</description>
	<errorDescription>Multiple input errors.</errorDescription>
</DuplicateCheck>
</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>
	<DuplicateCheck>
	<statusCode>44</statusCode>
	<description>FAIL</description>
	<errorDescription>Input error.</errorDescription>
</DuplicateCheck>
</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>
	<DuplicateCheck>
	<statusCode>46</statusCode>
	<description>FAIL</description>
	<errorDescription>Internal duplicate.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: Internal duplicate.
How to Resolve?: Provide another data.
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>
	<DuplicateCheck>
	<statusCode>47</statusCode>
	<description>FAIL</description>
	<errorDescription>H2O is down.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: H2O is down.
How to Resolve?: H2O is down. Please try again later.
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>
	<DuplicateCheck>
	<statusCode>49</statusCode>
	<description>FAIL</description>
	<errorDescription>H2O Duplicate.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: H2O Duplicate.
How to Resolve?: H2O is a duplicate value.
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>
	<DuplicateCheck>
	<statusCode>50</statusCode>
	<description>FAIL</description>
	<errorDescription>HOUSEHOLD::Household in H2O.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: HOUSEHOLD::Household in H2O.
How to Resolve?: Duplicate address is coming in H2O.
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>
	<DuplicateCheck>
	<statusCode>56</statusCode>
	<description>FAIL</description>
	<errorDescription>Internal duplicate checking API is down. Please try again later.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: Internal duplicate checking API is down. Please try again later.
How to Resolve?: Internal duplicate checking API is down. Please try again later.
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>
	<DuplicateCheck>
	<statusCode>66</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid date format.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: Invalid date format.
How to Resolve?: Please provide date in defined format.
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>
	<DuplicateCheck>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
	<DuplicateCheck>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</DuplicateCheck>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

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