NladVerifyEbb

This XML API calls NLAD Verify EBB API and returns direct response from NLAD.

End Point https://www.vcareapi.com/vcareOssApi/NladVerifyEbb/
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.
COMPANYID Numeric 28 Required A unique Company ID assigned to the MVNO. This can be obtained using another API called GetCompany.
FirstName string John Required Applicant's first name. Only English 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.
MiddleName string A Optional Applicant's middle name. Only English 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.
LastName string Doe Required Applicant's last name. Only English 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.
DOB string YYYY-MM-DD Required This is the date of birth of the applicant. YYYY-MM-DD is expected.
Last four digits of SSN string 1234 Required Last four digits of the social security number of the applicant. Only four digits are allowed.
QUALIFYING BENEFICIARY SAME AS CUSTOMER string N Required "An individual eligible for Lifeline Program benefits when the subscriber does not qualify. Typically, this person cannot subscribe to a carrier on their own, and is a dependent of the subscriber. The value Y determines that the qualifying beneficiary is the applicant itself. N determines that qualifying beneficiary is someone else other then applicant". 'Y' or 'N'
BENEFICIARY FIRST NAME string John Conditional First name of the qualifying beneficiary. This is to be passed in the API only when QUALIFYING BENEFICIARY SAME AS CUSTOMER is passed as N. Only English 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.
BENEFICIARY MIDDLE NAME string A Conditional Middle name of the qualifying beneficiary. This is to be passed in the API only when QUALIFYING BENEFICIARY SAME AS CUSTOMER is passed as N. Only English 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.
BENEFICIARY LAST NAME string Doe Conditional Last name of the qualifying beneficiary. This is to be passed in the API only when QUALIFYING BENEFICIARY SAME AS CUSTOMER is passed as N Only English 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.
BENEFICIARY BIRTHDATE string 1985-12-01 Conditional Date of birth of the qualifying beneficiary.This is to be passed in the API only when QUALIFYING BENEFICIARY SAME AS CUSTOMER is passed as N. 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.This is to be passed in the API only when QUALIFYING BENEFICIARY SAME AS CUSTOMER is passed as N. No hyphen allowed. beneficiary SSN/Tribal ID is required.
BENEFICIARY TRIBAL ID string 242343 Conditional This is the tribal ID of the beneficiary.This is to be passed in the API only when QUALIFYING BENEFICIARY SAME AS CUSTOMER is passed as N. No hyphen allowed. beneficiary SSN/Tribal ID is required.
Address 1 string 123 Main St Required 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".
Address 2 string Houston Optional This is the service address 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 Baltimore Required City for the service address.
STATE string TX Required State for the service address. State should be standard abbreviated form.
ZIPCODE Numeric 21215 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.
PROGRAM CODE string SNAP Required The NLAD program code under which the subscriber is eligible for Lifeline Program benefits. These are returned in getProgramIncomeList XML API
HOUSEHOLD string Y Optional Independent Economic Household certification, whereby an ETC can certify that a Lifeline Program subscriber is sharing an address with another eligible subscriber. 'Y' or 'N'
TRIBAL string N Optional This refers to a Tribal lands part of the Lifeline Program where additional funds are offered to Lifeline Program subscribers living on Tribal lands. Y' or 'N'
TOTAL ANNUAL INCOME string N Optional 1000 Total annual income of the applicant. Needs to be passed only when subscriber does not qualify on the basis of eligibility programs.
SERVICE TYPE string Voice Required This is the plan service type. Expected values: Voice, Broadband, Bundled Voice, Bundled Broadband, Bundled Voice and Broadband.
PRIMARY URBANIZATION CODE string 1234sf12 Optional Applicable for the state of Puerto Rico.
MAILING URBANIZATION CODE string 1234sf12 Optional Applicable for the state of Puerto Rico.
SCHOOL NAME string Enter your school name Optional Please enter your school name.
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>Vcarecorporation</VENDORID>
<USERNAME>Vcarecorporation</USERNAME>
<PASSWORD>Vcarecorporation</PASSWORD>
<PIN>123456789</PIN>
<REFERENCENUMBER>123456789</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
  <NLADVERIFYEBB>
	<COMPANY_ID></COMPANY_ID>
	<FIRSTNAME></FIRSTNAME>
	<MIDDLENAME></MIDDLENAME>
	<LASTNAME></LASTNAME>
	<DOB></DOB>
	<LAST4SSN></LAST4SSN>
	<BENEFICIARYSAMEASCUSTOMER></BENEFICIARYSAMEASCUSTOMER>
	<BENEFICIARYFIRSTNAME></BENEFICIARYFIRSTNAME>
	<BENEFICIARYMIDDLENAME></BENEFICIARYMIDDLENAME>
	<BENEFICIARYLASTNAME></BENEFICIARYLASTNAME>
	<BENEFICIARYDOB></BENEFICIARYDOB>
	<BENEFICIARYSSN></BENEFICIARYSSN>
	<BENEFICIARYTRIBALID></BENEFICIARYTRIBALID>
	<SERV_ADD1></SERV_ADD1>
	<SERV_ADD2></SERV_ADD2>
	<CITY></CITY>
	<STATE></STATE>
	<ZIP></ZIP>
	<PROGRAMCODE></PROGRAMCODE>
	<HOUSEHOLD></HOUSEHOLD>
	<TRIBAL></TRIBAL>
	<TOTALANNUALINCOME></TOTALANNUALINCOME>
	<SERVICETYPE></SERVICETYPE>
	<PRIMARYURBANIZATIONCODE></PRIMARYURBANIZATIONCODE>
	<MAILINGURBANIZATIONCODE></MAILINGURBANIZATIONCODE>
	<SCHOOLNAME></SCHOOLNAME>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
  </NLADVERIFYEBB>
</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.
244 NLAD verification failed. NLAD verification failed.
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></vendorId>
	<referenceNumber></referenceNumber>
</credentials>
<NLADVERIFYEBB>
	<statusCode>00</statusCode>
	<description>SUCCESS</description>
	<errorDescription>SUCCESS</errorDescription>
	<msg></msg>
	<enrollmentid></enrollmentid>
	<nlad_nv></nlad_nv>
	<proof_required_nv></proof_required_nv>
	<msg_code></msg_code>
	<data></data>
</NLADVERIFYEBB>
</VcareOssApi>
Success::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></vendorId>
  <referenceNumber></referenceNumber>
</credentials>
 <NladVerifyEbb>
  <statusCode>13</statusCode>
  <description>FAIL</description>
  <errorDescription>Password is invalid.</errorDescription>
  <msg></msg>
</NladVerifyEbb>
</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></vendorId>
  <referenceNumber></referenceNumber>
</credentials>
 <NladVerifyEbb>
  <statusCode>16</statusCode>
  <description>FAIL</description>
  <errorDescription>Vendor not found. Wrong credentials.</errorDescription>
  <msg></msg>
</NladVerifyEbb>
</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></vendorId>
  <referenceNumber></referenceNumber>
</credentials>
 <NladVerifyEbb>
  <statusCode>244</statusCode>
  <description>FAIL</description>
  <errorDescription>NLAD verification failed.</errorDescription>
  <msg></msg>
</NladVerifyEbb>
</VcareOssApi>
Error Description: NLAD verification failed.
How to Resolve?: NLAD verification failed.
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></vendorId>
  <referenceNumber></referenceNumber>
</credentials>
 <NladVerifyEbb>
  <statusCode>751</statusCode>
  <description>FAIL</description>
  <errorDescription>Custom message.</errorDescription>
  <msg></msg>
</NladVerifyEbb>
</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.