CheckApplicationStatus

This XML API is used to get the information from the subscriber's account application.

End Point https://www.vcareapi.com/vcareOssApi/CheckApplicationStatus/
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.
ENROLLMENT ID string 123456 Conditional Auto generated customer account number If you are not passing customerid and telephonenumber then enrollmentid is required
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
FIRST NAME string 28 Conditional OnlyEnglish 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. MDN and Last name is supposed to be passed together. If you are passing the Customer Id then MDN and Last name are not required
LAST NAME string 28 Conditional OnlyEnglish 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. MDN and Last name is supposed to be passed together. If you are passing the Customer Id then MDN and Last name are not required
AGENTID string John Doe Required This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENTPASSWORD string John Doe 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,POS
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>
<CHECKAPPLICATIONSTATUS>
	<ENROLLMENTID></ENROLLMENTID>
	<SSNNUMBER></SSNNUMBER>
	<FIRSTNAME></FIRSTNAME>
	<LASTNAME></LASTNAME>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</CHECKAPPLICATIONSTATUS>
</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.
81 Enrollment ID should not be blank. Please provide Enrollment id. Enrollment id cannot be left blank.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
455 SSN number should not be blank. Enter a valid SSN. SSN should not be blank.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
491 No record(s) found. No record(s) found.
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>Vcarecorporation</vendorId>
        <referenceNumber>1111111</referenceNumber>
    </credentials>
    <CheckApplicationStatus>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <enrollmentid></enrollmentid>
        <fname></fname>
        <mname></mname>
        <lname></lname>
        <address_type></address_type>
        <serv_add1></serv_add1>
        <serv_add2></serv_add2>
        <city></city>
        <state></state>
        <zip></zip>
        <mail_add1></mail_add1>
        <mail_add2></mail_add2>
        <mailcity></mailcity>
        <mailstate></mailstate>
        <mailzip></mailzip>
        <ben_fname></ben_fname>
        <ben_middlename></ben_middlename>
        <ben_lastname></ben_lastname>
        <phone_number></phone_number>
        <dob></dob>
        <email></email>
        <drivingLicence></drivingLicence>
        <ssn_number></ssn_number>
        <tribal_id></tribal_id>
        <ssn_type></ssn_type>
        <plan_id></plan_id>
        <ssn_noverify></ssn_noverify>
        <application_source></application_source>
        <application_createdby></application_createdby>
        <application_status></application_status>
        <application_reason></application_reason>
        <enrolled_date_time></enrolled_date_time>
        <response_datetime></response_datetime>
    </CheckApplicationStatus>
</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>
<CheckApplicationStatus>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</CheckApplicationStatus>
</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>
<CheckApplicationStatus>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</CheckApplicationStatus>
</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>
<CheckApplicationStatus>
	<statusCode>81</statusCode>
	<description>FAIL</description>
	<errorDescription>Enrollment ID should not be blank.</errorDescription>
</CheckApplicationStatus>
</VcareOssApi>
Error Description: Enrollment ID should not be blank.
How to Resolve?: Please provide Enrollment id. Enrollment id cannot be left blank.
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>
<CheckApplicationStatus>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</CheckApplicationStatus>
</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>
<CheckApplicationStatus>
	<statusCode>455</statusCode>
	<description>FAIL</description>
	<errorDescription>SSN number should not be blank.</errorDescription>
</CheckApplicationStatus>
</VcareOssApi>
Error Description: SSN number should not be blank.
How to Resolve?: Enter a valid SSN. SSN should not be blank.
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>
<CheckApplicationStatus>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</CheckApplicationStatus>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<CheckApplicationStatus>
	<statusCode>491</statusCode>
	<description>FAIL</description>
	<errorDescription>No record(s) found.</errorDescription>
</CheckApplicationStatus>
</VcareOssApi>
Error Description: No record(s) found.
How to Resolve?: No record(s) found.

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