eligibility_check Navigate to XML API

This REST API is used to check whether the customer is eligible is or not take the LIFELINE or ACP services.

End Point https://www.vcareapi.com:8080/nlad
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action String eligibility_check Required This needs to be passed as eligibility_check Expected values : eligibility_check
enrollment_id String WA78945 Required 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
first_name String John Required This is the first name of the applicant. Accepts these special characters: space, apostrophe (‘), accent Grave (`), hyphen (-). Minimum of 1 alphabetic character.
source String API Required Source of the order/application/API call Expected Value : API , WEBSITE
agent_id String JohnDoe Required This is the Telgoo5 user id for the Agent/Employee who is sending the API request. This is the user login id which will be created in Telgoo5 for the API user.
middle_name String Doe Optional This is the middle name of the applicant. Accepts these special characters: space, apostrophe (‘), accent Grave (`), hyphen (-). Minimum of 1 alphabetic character
last_name String Doe Required This is the last name of the applicant. Accepts these special characters: space, apostrophe (‘), accent grave (`), hyphen (-). Minimum of 2 alphabetic characters.
address_one String ABC Main St Required Here you should pass the House number and Street of the applicant's address Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
address_two String apt 7 Optional Here you should pass the apartment number of the applicant's service address. Accepts these special characters: space, forward slash (/), hash (#), hyphen (-)
city String CAMDEN Required This is the service address city of the applicant. Should allow only letters, hyphen and space.
state String NJ Required This is the service address state of the applicant. State should be standard abbreviated form. Maximum two characters are allowed.
zip_code String 08104 Required This is the service address zipcode of the applicant. Should not allow letters and special characters, only numbers. Should be exactly 5 digits.
ssn String 1234 Optional This is the social security number of the applicant. No hyphen allowed
dob String 1985-12-01 Required This is the date of birth of the applicant. YYYY-MM-DD is expected. Hyphen allowed.
tribal_id String Optional This defines whether the customer is tribal or not.
beneficiary_first_name String John Optional If qualifying beneficiary same as customer then not 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 Optional If qualifying beneficiary same as customer then not 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_dob String 1985-12-01 Optional If qualifying beneficiary same as customer then not required. This is the date of birth of the applicant. YYYY-MM-DD is expected.
beneficiary_ssn String 1234 Optional If qualifying beneficiary same as customer then not 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.
program_code String SNAP Optional Program codes are the government assistance program. program_code is returned in programs_income_list api and you need to pass the same program code. Example MEDIC , SNAP
no_of_household String 1 Optional 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
carrier_url String http://xyz.com Optional The Carrier URL serves as the destination link where customers are directed to continue their enrollment process, which includes choosing a plan and device, after providing their information on NV. Valid carrier url.
agent_password String ********* Optional 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 REST 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 REST API.
contact_phone String 1234567891 Optional This is the customer phone number. Numeric
contact_email String test@test.com Optional Subscriber's contact email address. A valid emai address
mailing_address_one String ABC Main St Optional This is the mailing address line 1 of the applicant. Here you should pass the Street and House number of the applicant. Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
mailing_address_two String Apt 1 Optional This is the mailing address line 2 of the applicant. Here you should pass the apartment number of the applicant. Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
mailing_city String CAMDEN Optional This is the mailing address city of the applicant. Should allow only letters, hyphen and space.
mailing_state String NJ Optional This is the mailing address state of the applicant. State should be standard abbreviated form. Maximum two characters are allowed.
mailing_zip numeric 08104 Optional This is the mailing address zipcode of the applicant. Should not allow letters and special characters, only numbers. Should be exactly 5 digits.
public_housing_code numeric Optional Federal Public Housing Program options
1 - Housing Choice Voucher Program
2 - Project-based rental assistance
3 - Public housing
4 - Affordable Housing Programs for American Indians, Alaska Natives or Native Hawaiians
 For ACP Only. Numeric
Sample Request REST
{
  "enrollment_id": "EGK1899",
  "first_name": "JOHN",
  "middle_name": "",
  "last_name": "DOE",
  "address_one": "4242 BONNER RD",
  "address_two": "APT 2",
  "beneficiary_first_name": "",
  "beneficiary_middle_name": "",
  "beneficiary_last_name": "",
  "beneficiary_dob": "",
  "beneficiary_ssn": "",
  "beneficiary_tribal_id": "",
  "city": "Baltimore",
  "state": "MD",
  "zip_code": "21229",
  "tribal_id": "Y",
  "ssn": "1235",
  "dob": "1996-01-03",
  "program_code": [
    "SNAP"
  ],
  "no_of_household": "",
  "action": "eligibility_check",
  "agent_id": "ewebsiteapi",
  "source": "WEBSITE",
  "carrier_url": "https://enrollments.telgoo5.com/BUYFLOW/enrollment2/programm_list.php?nvldone=1",
  "public_housing_code": "",
  "request_name": "nlad"
}
List of status code, description and resolution.
Status Code Description How to Resolve?
RESTAPI000 SUCCESS SUCCESS
RESTAPI001 FAIL Multiple errors like Invalid Token, Token already used, Token expire & Invalid Access!!
RESTAPI101 FAIL Module required.
RESTAPI102 FAIL Action required.
RESTAPI103 FAIL Source Not Allowed.
RESTAPI104 FAIL Invalid Agent ID or Password.
RESTAPI105 FAIL Module does not exist.
RESTAPI106 FAIL Action does not exist.
RESTAPI107 FAIL Invalid company.
RESTAPI108 FAIL Invalid method.
RESTAPI109 FAIL Unauthorized Access.
RESTAPI010 FAIL Multiple errors come in an array.
Sample Response
{
    "data": {
        "activeSubscriber": "Y",
        "applicationId": "B41592-60201",
        "coordinateSource": "Automated",
        "eligibilityCheckId": "B8C1BE0E96424602DD63FDDF42D8B57B7E73E9B867C36B2AE3002FA216015652",
        "eligibilityExpirationDate": "2023-03-02",
        "latitude": "40.610084",
        "longitude": "-111.864297",
        "status": "COMPLETE",
        "tribalStatusConfirmed": "N"
    },
    "msg": "Success",
    "msg_code": "RESTAPI000",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGVtby1Hb2t3c1VzZXIiLCJwYXNzd29yZCI6IkRlbW8tR29rd3N0SzEyM2h5dXRydzIxIiwicGluIjoiRGVtby02MzIxNjc0MTY0NzQ1OCIsInZlbmRvcl9pZCI6IkRlbW8tR29rbm93cyIsImxvZ19pZCI6MTI0ODU0MCwidXJsIjoiaHR0cHM6Ly9kZW1vLWdva25vd3MudGVsZ29vNS5jb20vdmNhcmVPc3NBcGkvIn0sImV4cCI6MTcwNDgyMjI1OH0.QTroKXLLPCKqTmgyCbVvoXeHamWepSsnFrRCdcyaCIM"
}
SUCCESS
Sample Fail Response: 1
{
    
    "msg": "Invalid Token",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Token
How to Resolve?: Provide valid token in header
Sample Fail Response: 2
{
    
    "msg": "Invalid Access!!",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Access!!
How to Resolve?: Request method will be POST
Sample Fail Response: 3
{
    "errors":["Source Not Allowed"]
    "msg": "Source Not Allowed",
    "msg_code": "RESTAPI103",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Source Not Allowed
How to Resolve?: Provide valid Source
Sample Fail Response: 4
{
    "errors":["Agent Id should not be blank"]
    "msg": "Agent Id should not be blank",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Agent Id should not be blank
How to Resolve?: Provide valid Agent Id
Sample Fail Response: 5
{
    "errors":["Invalid Agent Id"]
    "msg": "Invalid Agent Id",
    "msg_code": "RESTAPI104",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Invalid Agent Id
How to Resolve?: Provide valid Agent Id
Sample Fail Response: 6
{
    
    "msg": "Token already used",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Token already used
How to Resolve?: You can use token once per request
Sample Fail Response: 7
{
    
    "msg": "Token expire",
    "msg_code": "RESTAPI001",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Token expire
How to Resolve?: Create token again
Sample Fail Response: 8
{
    "errors":["Please enter Enrollment Id"]
    "msg": "Error occurred",
    "msg_code": "RESTAPI110",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGV2LVR4TW9iaWxlVXNlciIsInBhc3N3b3JkIjoiRGV2LVR4TW9iaWxlUFdEIiwicGluIjoiRGV2LVR4UGluMjAxNyIsInZlbmRvcl9pZCI6IkRldi1UeE1vYmlsZSIsImxvZ19pZCI6ODA0ODMxLCJ1cmwiOiJodHRwczovL2Rldi10eG1vYmlsZS52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNTYxNDY4NjI0fQ.9iDehEddu46AKDCVWwl26ZSTTaiKt4GWKn7dUIcIspQ"
}
Error Description: Error occurred
How to Resolve?: Provide Enrollment Id

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