address_validation Navigate to XML API

This REST API determines whether a location is serviceable or not based on USPS (United States Postal Service) criteria. This REST API is used in case of ACP and Lifeline services.

End Point https://www.vcareapi.com:8080/address
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action String address_validation Required This needs to be passed as address_validation address_validation
enrollment_id String AN12345 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 Applicant's first name. Accepts these special characters: space, apostrophe (‘), accent Grave (`), hyphen (-). Minimum of 1 alphabetic character.
middle_name String Doe Optional Applicant's middle name. Accepts these special characters: space, apostrophe (‘), accent Grave (`), hyphen (-). Minimum of 1 alphabetic character
last_name String Doe Required Applicant's last name. Accepts these special characters: space, apostrophe (‘), accent grave (`), hyphen (-). Minimum of 2 alphabetic characters.
address_one String ABC main street Required Here you should pass the House number and Street of the applicant's service address Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
address_two String Apt 2 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 City for the service address. Accepts these special characters: space, hyphen (-).
state String NJ Required State for the service address. State should be standard abbreviated form. Maximum two characters are allowed.
zip_code String 08104 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.
dob String 2004-08-02 Required Date of Birth of the applicant. Date format should be YYYY-MM-DD
ssn String 1234 Required Last four digits of the social security number of the applicant. Only four digits are allowed.
address_validation String Y Optional This is the address_validation field, this field implies whether you want to verify the address from USPS or not . Default value is Y. If you do not want to verify the address than select it as N. Y or N.
source String API Required Source of the order/application Expected Value : API , WEBSITE
agent_id String John Doe 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.
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.
mailing_address_one String ABC main street Optional Here you should pass the House number and Street of the applicant's mailing address The mailing address of the subscriber (line 1 / street address). Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
mailing_address_two String Apt 2 Optional Here you should pass the apartment number of the applicant's mailing address. The mailing address of the subscriber (line 2 / secondary address). 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.
mailing_zip String 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.
beneficiary_first_name String Ryan Optional If qualifying beneficiary is same as customer then this is not required, if it is different then you need to pass the first name of the qualifying beneficiary in this field. 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_middle_name String Jude Optional If qualifying beneficiary is same as customer then this is not required, if it is different then you need to pass the middle name of the qualifying beneficiary in this field. 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 Matthew Optional If qualifying beneficiary is same as customer then this is not required, if it is different then you need to pass the last name of the qualifying beneficiary in this field. 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_suffix String Optional If qualifying beneficiary is same as customer then this is not required, if it is different then you need to pass the suffix name of the qualifying beneficiary in this field. 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_ssn String 1423 Optional If qualifying beneficiary is same as customer then this is not required, if it is different then you need to pass the last four digits of the SSN of the qualifying beneficiary in this field. No hyphen allowed. beneficiary SSN/Tribal ID is required.
beneficiary_dob String 1987-03-14 Optional If qualifying beneficiary is same as customer then this is not required, if it is different then you need to pass the Date of Birth of the qualifying beneficiary in this field. YYYY-MM-DD is expected.
initial_choosen_enrollment_type String LIFELINE Required If the customer is enrolling for ACP than you should type here ACP.
If the customer is enrolling for Lifeline than you should type here LIFELINE.
If the customer is enrolling for COMBO than you should type here COMBO.		 Expected values: ACP - For only ACP orders , LIFELINE - For only Lifeline orders , COMBO - For ACP + Lifeline orders
lifeline_enrollment_type String LIFELINE Required This is initial chosen enrollment type. This value depends on initial_choosen_enrollment_type

If initial_choosen_enrollment_type is COMBO then this value should be LIFELINE

If initial_choosen_enrollment_type is LIFELINE then this value should be LIFELINE

If initial_choosen_enrollment_type is EBB then this value should be EBB		 Expected values : For Lifeline orders - LIFELINE, For ACP orders - ACP , For Combo orders - ACP + Lifeline
ebb_verify_type String NV Required This is the ACP verify type. Expected value NV
agent_code String 123arv56 Optional This is the agent code.
nl_customer_id numeric 450023 Optional This is only required to be passed if you are enrolling a prepaid (non-lifeline subscriber) in ACP program. Numeric
refersion_code String Optional Use for tracking the orders that are coming from a particular agent.
Sample Request REST
{
    "enrollment_id": "ETG57860",
    "first_name": "JOHN",
    "middle_name": "",
    "last_name": "DOE",
    "address_one": "743 WHEATLAND CT",
    "address_two": "",
    "city": "CAMDEN",
    "state": "NJ",
    "zip_code": "08104",
    "is_temp": "N",
    "ssn": "1234",
    "dob": "2004-08-02",
    "mailing_address_one": "",
    "mailing_address_two": "",
    "mailing_city": "CAMDEN",
    "mailing_state": "NJ",
    "mailing_zip": "08104",
     "beneficiary_suffix": "",
  "beneficiary_first_name": "",
  "beneficiary_middle_name": "",
  "beneficiary_last_name": " ",
  "beneficiary_dob": "",
  "beneficiary_ssn": "",
    "action": "address_validation",
    "agent_id": "Devteam",
    "source": "WEBSITE",
    "lifeline_enrollment_type": "ACP",
    "initial_choosen_enrollment_type": "ACP",
    "ebb_verify_type": "NV",
    "request_name": "address",
    "vendor_id": "Demo-Telgoo5demo"
}
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": {
        "address_status": "CONFIRMED",
        "as_16": null,
        "as_17": null,
        "city": "CAMDEN",
        "internal_duplicate_status": "NODUPLICATE",
        "is_shelter_address": "N",
        "is_tribal": "N",
        "melissareturnaddress": "743 WHEATLAND CT  CAMDEN NJ 08104",
        "service_address_one": "743 WHEATLAND CT",
        "service_address_two": "NA",
        "state": "NJ",
        "zipcode": "08104"
    },
    "msg": "Success",
    "msg_code": "RESTAPI000",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiVGVsZ29vNVVzZXIiLCJwYXNzd29yZCI6Ind0S2h5dXRyd25ZNiIsInBpbiI6IjMyMTY3NDE2NDY1NDQiLCJ2ZW5kb3JfaWQiOiJUZWxnb281UHJvZHVjdGlvbiIsImxvZ19pZCI6MjI1MTgwMDczNDgyNzY4MywidXJsIjoiaHR0cHM6Ly90ZWxnb281ZGVtby52Y2FyZWNvcnBvcmF0aW9uLmNvbS92Y2FyZU9zc0FwaS8ifSwiZXhwIjoxNzAxMjkwOTEwfQ.Yx35bdvUqwFXT9lUcbP1sjcG0fx4HVTgHUADg6GLVzQ"
}
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.