Eligibility Check Natonal Verifier

This API is used to Eligibility Check Natonal Verifier in Telgoo5.

End Point https://www.vcareapi.com/vcareOssApi/EligibilityCheckNationalVerifier/
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 A12345 Conditional 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
FIRST NAME 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.
MIDDLE NAME string A Optional This is the middle name of the applicant. Only English alphabet letters, space, apostrophe, Accent Grave ("`"), period and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
LAST NAME 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.
BIRTH DATE string 1985-12-01 Required This is the date of birth of the applicant. YYYY-MM-DD is expected. hyphen allowed.
SOCIAL SECURITY NUMBER Numeric 1234 Required 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
TRIBAL ID Alphanumeric abc123 Conditional The Tribal identification number, or Tribal enrollment number of the consumer. ETCs that have collected partial Tribal IDs may submit them so long as they have at least two characters. This field accepts some Conditional (required if no ssn4)
BENEFICIARY FIRST NAME string John Conditional 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 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 This is the date of birth of the applicant. YYYY-MM-DD is expected.
BENEFICIARY SOCIAL SECURITY NUMBER Numeric 1234 Conditional 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.
BENEFICIARY TRIBAL ID Alphanumeric abc123 Conditional Benefit Qualifying Person's (BQP) tribal identification number. Conditional (required if using any bqp fields and no bqpTribalId)
SERVICE 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".
SERVICE 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".
SERVICE CITY string Houston Required This is the service address city of the applicant. Should allow only letters, hyphen and space.
SERVICE STATE string TX Required This is the service address state of the applicant. State should be standard abbreviated form.
SERVICE ZIPCODE Numeric 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.
MAILING ADDRESS1 string 123 Main St Required This is the mailing 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".
MAILING ADDRESS2 string Apt 1 Optional This is the mailing 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".
MAILING CITY string Houston Required This is the mailing address city of the applicant. Should allow only letters, hyphen and space.
MAILING STATE string TX Required This is the mailing address state of the applicant. State should be standard abbreviated form.
MAILING ZIPCODE Numeric 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.
PROGRAM CODE string SNAP Conditional These are returned in getProgramIncomeList XML API. If an applicant qualify on low income basis, you may pass empty tag and INCOMECERTIFY tag becomes Required. Multiple values example FPH::MEDIC::SNAP
NO OF HOUSEHOLD string 2 Conditional This determines the number of individuals living in the same household. This is require when applicant qualify based on low income. This tag becomes Required when INCOMECERTIFY has a value. Numeric
URBANIZATION CODE string 11 Optional This field is used only for Puerto Rico addresses that have an urbanization code.
TELEPHONE NUMBER string 1234567890 Conditional This is alternate telephone number of the applicant. hyphen not allowed
CONTACT EMAIL string noemail@gmail.com Conditional This is the email address of the applicant.
CONSENT IND string consent Required

Indicates if consumer has provided their consent with providing their PII for the

Y - Consumer has provided their consent to share their information for purposes of applying and/or receiving the Lifeline benefit.

N - Consumer has not provided their consent to share their information for purposes of applying and/or receiving the Lifeline benefit.

 Y or N
CONACT URB CODE string URB CODE Optional This field is used only for Puerto Rico addresses that have an urbanization code. Alphabetic
CARRIER URL string Carrier URL Optional Carrier can provide a callback return URL so that the user can return to the carrier's website after completing the appropriate steps of their Lifeline application within the National Verifier. Alphanumeric
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/API call Expected Value:API, TABLET, IVR, WEBSITE, CSR, POS
Sample Request
<?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>
	<ELIGIBILITYCHECKNATIONALVERIFIER>
		<ENROLLMENTID></ENROLLMENTID>
		<FIRSTNAME></FIRSTNAME>
		<MIDDLENAME></MIDDLENAME>
		<LASTNAME></LASTNAME>
		<DOB></DOB>
		<LAST4SSN></LAST4SSN>
		<TRIBAL_ID></TRIBAL_ID>
		<BENEFICIARYFIRSTNAME></BENEFICIARYFIRSTNAME>
		<BENEFICIARYLASTNAME></BENEFICIARYLASTNAME>
		<BENEFICIARYDOB></BENEFICIARYDOB>
		<BENEFICIARYSSN></BENEFICIARYSSN>
		<BENEFICIARYTRIBALID></BENEFICIARYTRIBALID>
		<ADDRESS1></ADDRESS1>
		<ADDRESS2></ADDRESS2>
		<CITY></CITY>
		<STATE></STATE>
		<ZIP></ZIP>
		<MAIL_ADDRESS1></MAIL_ADDRESS1>
		<MAIL_ADDRESS2></MAIL_ADDRESS2>
		<MAIL_CITY></MAIL_CITY>
		<MAIL_STATE></MAIL_STATE>
		<MAIL_ZIP></MAIL_ZIP>
		<PROGRAMCODE></PROGRAMCODE>
		<NO_OF_HOUSEHOLD></NO_OF_HOUSEHOLD>
		<URBANIZATIONCODE></URBANIZATIONCODE>
		<TELEPHONE_NUMBER></TELEPHONE_NUMBER>
		<contact_email></CONTACT_EMAIL>
		<CARRIERURL></CARRIERURL>
		<CONSENT_IND></CONSENT_IND>
		<CONACT_URB_CODE></CONACT_URB_CODE>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	</ELIGIBILITYCHECKNATIONALVERIFIER>
</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.
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>vcare</vendorId>
	<referenceNumber>9433611785</referenceNumber>
</credentials>
<EligibilityCheckNationalVerifier>
	<statusCode>00</statusCode>
	<description>SUCCESS</description>
	<errorDescription>SUCCESS</errorDescription>
	<enrollmentid>T544219</enrollmentid>
	<applicationId>Q56262-20385</applicationId>
	<eligibilityCheckId>AD648684B060B83888C99A071EB042BA691FF20B0CCEF2AC1412A84BB7134ADB</eligibilityCheckId>
	<status>PENDING_CERT</status>
	<eligibilityExpirationDate>2021-03-29</eligibilityExpirationDate>
	<activeSubscriber>Y</activeSubscriber>
	<tribalStatusConfirmed></tribalStatusConfirmed>
	<latitude></latitude>
	<longitude></longitude>
	<coordinateSource></coordinateSource>
	<_links>https://api.universalservice.org/nvca-svc/security/getPage?id=AD648684B060B83888C99A071EB042BA691FF20B0CCEF2AC1412A84BB7134ADB&token=4fc6dab7a6386155b4d313077cb78f14919cdc2a09561003b483ac90c2913328</_links>
	<failures>PENDING_CERT::You are eligible for lifeline service, but you must complete all required Certifications in National Verifier</failures>
	<msg_code>NLAD000</msg_code>
	<nv_array_tribal_state_nlad_global>N</nv_array_tribal_state_nlad_global>
</EligibilityCheckNationalVerifier>

</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>
	<EligibilityCheckNatonalVerifier>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</EligibilityCheckNatonalVerifier>
</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>
	<EligibilityCheckNatonalVerifier>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</EligibilityCheckNatonalVerifier>
</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>
	<EligibilityCheckNatonalVerifier>
	<statusCode>59</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Enrollment ID.</errorDescription>
</EligibilityCheckNatonalVerifier>
</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>
	<EligibilityCheckNatonalVerifier>
	<statusCode>81</statusCode>
	<description>FAIL</description>
	<errorDescription>Enrollment ID should not be blank.</errorDescription>
</EligibilityCheckNatonalVerifier>
</VcareOssApi>
Error Description: Enrollment ID should not be blank.
How to Resolve?: Please provide Enrollment id. Enrollment id cannot be left blank.

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