NladEtcVerify

This XML API calls NLAD ETC Check API and returns the direct response from NLAD.

End Point https://www.vcareapi.com/vcareOssApi/NladEtcVerify/
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.
LAST4SSN Numeric 1234 Required Last four digits of the social security number of the applicant. Only four digits are allowed.
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.
BIRTH DATE string YYYY-MM-DD Required This is the date of birth of the applicant. YYYY-MM-DD is expected.
ADDRESS 1 string 123 Main St Required This is the service address line 1 of the applicant.
ADDRESS 2 string Houston Optional This is the service address line 2 of the applicant.
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.
ZIP CODE Numeric 73001 Required Applicants address zip code. Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
COMPANYID Numeric 28 Conditional A unique Company ID assigned to the MVNO. This can be obtained using another API called GetCompany. Numeric
PRIMARY URBANIZATION CODE string 1234sf12 Optional Applicable for the state of Puerto Rico.
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 This is the source where the API. This could be API, TABLET, IVR etc.
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>
  <NLADETCVERIFY>
	<LAST4SSN></LAST4SSN>
	<FIRSTNAME></FIRSTNAME>
	<MIDDLENAME></MIDDLENAME>
	<LASTNAME></LASTNAME>
	<DOB></DOB>
	<SERV_ADD1></SERV_ADD1>
	<SERV_ADD2></SERV_ADD2>
	<CITY></CITY>
	<STATE></STATE>
	<ZIP></ZIP>
	<COMPANY_ID></COMPANY_ID>
	<PRIMARYURBANIZATIONCODE></PRIMARYURBANIZATIONCODE>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
 </NLADETCVERIFY>
</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.
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.
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></vendorId>
        <referenceNumber></referenceNumber>
    </credentials>
    <NladEtcVerify>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>TPIV WebService","Subscriber identity could not be found.","TPIV_FAIL_IDENTITY_NOT_FOUND","The subscriber\u0027s identity could not be found"],["TPIV WebService","Subscriber failed third-party identity verification.","TPIV_FAIL","The subscriber has failed the third party Identification</errorDescription>
    </NladEtcVerify>
</VcareOssApi>

SUCCESS

TPIV WebService","Subscriber identity could not be found.","TPIV_FAIL_IDENTITY_NOT_FOUND","The subscriber\u0027s identity could not be found"],["TPIV WebService","Subscriber failed third-party identity verification.","TPIV_FAIL","The subscriber has failed the third party Identification

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>
	<NladEtcVerify>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</NladEtcVerify>
</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>
	<NladEtcVerify>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</NladEtcVerify>
</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>
	<NladEtcVerify>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</NladEtcVerify>
</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>
	<NladEtcVerify>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</NladEtcVerify>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
	<NladEtcVerify>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</NladEtcVerify>
</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.