create_lifeline_customer Navigate to XML API

This API is used to create a lifeline subscriber in Telgoo5.

End Point https://www.vcareapi.com:8080/customer
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action String create_lifeline_customer Required This needs to be passed as create_lifeline_customer create_lifeline_customer
first_name String John Required This is the first name of the applicant. 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.
last_name String Doe Required This is the last name of the applicant. 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.
dob String 1985-12-01 Required This is the date of birth of the applicant. YYYY-MM-DD is expected. hyphen allowed.
ssn String 1234 Required This is the social security number of the applicant. No hyphen allowed.
best_way_to_reach String Email Required Here you should pass the best way to reach out to the customer. email, phone, text message
service_address_one String ABC Main St Required This is the service address line 1 of the applicant. Here you should pass the House number and street of the applicant. Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
service_city String CAMDEN Required This is the service address city of the applicant. Should allow only letters, hyphen and space.
service_state String NJ Required This is the service address state of the applicant. State should be standard abbreviated form. Maximum two characters are allowed.
service_zip 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.
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_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 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.
address_type String N Required This is used to determine if the applicants address is temporary or permanent.'Y' is considered as the temporary address and 'N' is for the permanent address 'Y' or 'N'
enrollment_type String SHIPMENT Required If you are not shipping anything to the customer then enrollment_type should be HANDOVER else SHIPMENT. Expected values : HANDOVER , SHIPMENT.
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.
source String API Required Source of the order/application Expected Value : API , WEBSITE
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 : For Lifeline orders - LIFELINE, For ACP orders - ACP , For Combo orders - ACP + Lifeline
acp_benefit_transfer_question_two String Y or N Required if acp_benefit_transfer_consent Y then there should be value acp_benefit_transfer_question_one= Y or acp_benefit_transfer_question_two=Y
customer_classification_id String 2 Optional This is customer classification id returned in another API response called "CustomerClassification". This is returned in api response tag = id. Example :: ID=>CATEGORY :: 2=>Gold Customer 3=>Privileged Customer 4=>Silver Customers
enrollment_id String A12345 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
customer_suffix String Jr. Optional This is the suffix name of the applicant. Only allow Jr. or Sr. or II or III or IV or V.
middle_initial String A Optional This is the middle name of the applicant. Only English alphabet letters, space, apostrophe, Accent Grave ("`"), period and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
beneficiary_suffix String Jr. Optional This is the suffix name of the beneficiary. Only allow Jr. or Sr. or II or III or IV or V.
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_middle_name String A Optional This is the middle 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.
beneficiary_tribal_id String 242343 Optional If qualifying beneficiary same as customer then not required. This is the tribal ID of the beneficiary. No hyphen allowed. beneficiary SSN/Tribal ID is required
alternative_email String noemail@gmail.com Optional This is the alternate email address of the applicant. Valid Email address.
alternate_contact_name String John Doe Optional This is the name of a friend or family of whom alternate contact number is provided space is allowed
alternative_contact_number String 1234567890 Optional This is alternate telephone number of the applicant. hyphen not allowed
service_address_two String Apt 1 Optional This is the service 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_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 (-).
program_code String SNAP Required program_code is returned in programs_income_list api and you need to pass the same program code. Multiple values example MEDIC , SNAP
tribal_id String 1 Optional This defines whether the customer is tribal or not.
no_of_household numeric 2 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
plan_id String 1315 Required This is the plan id on which subscriber will be on. The plan id list is returned in plan_list api.  Valid plan id
household_lifeline String Y Optional This is the response to the IEH worksheet question. Y or N
household_adult String Y Optional This is the response to the IEH worksheet question. If an adult lives on the address Y or N
 These are to be determined by ETC on the basis of IEH worksheet
household_share String N Optional If you share the income and expenses with the adult who lives with you then Y else N These are to be determined by ETC on the basis of IEH worksheet
certify1 String Y Optional If IEH worksheet questions answers are compliant then you need to pass the responses to the IEH certification statement Y or N These are to be dermined by ETC on the basis of IEH worksheet
certify2 String Y Optional If IEH worksheet questions answers are compliant then you need to pass the responses to the IEH certification statement Y or N These are to be dermined by ETC on the basis of IEH worksheet
driver_license_number String DL01235 Optional This is only applicable when subscriber have driver license number.
address_validation String N Optional Default is Y. If you do not want to verify the address than select it as N. 'Y' or 'N'
is_rural String N Optional This determines if the subscriber is on rural address. 'Y' or 'N'
customer_prefix String Jr Optional This is the prefix for the customer's name
second_last_name String Optional This is the second last name of the customer. This is an option filed and is to be used only if the customer is from CA(California)
language_code String Optional This is the language code for the language in which the application form needs to be sent to customer. This is only required in CA (California) for lifeline orders.
print_font_size numeric Optional This is font size in which the application form needs to be sent to customer. This is only required in CA (California) for lifeline orders.
esn numeric Optional If enrollment_type is HANDOVER than you need to pass the ESN/SIM else it is not required. Valid ESN/SIM.
primary_telephone_number numeric Optional This is primary telephone number of the applicant.
email String noreply@gmail.com Required This is the email address of the applicant. Valid email address.
is_household String Y Optional This determines if there are multiple households on the address or not. If this then Y is you are required to pass the values all the Household requirements in different household tags. Expected Values: Y OR N
handover_type String cbe Optional If enrollment_type is HANDOVER than you need to pass cbe in this field. Expected field : cbe
carrier String TMB Optional This is the carrier on which you are activating the customer Valid carrier abbreviated form.
device_type String Phone Optional This is device type.
imei String 152436521234578 Optional This is the device-id/ IMEI of the device. If you are providing a device to the customer than you need to pass the IMEI/ device_id. Valid IMEI / device_id
dcnid String Optional This is only applicable when subscriber is from the state of MO (Missouri).
dshs_client_id String Optional This is only applicable when subscriber is from the state of WA (washington).
coordinate String Optional These are the co-ordinates for the location of the agent.
resolution String Optional Y/N
equipment_id String 3213 Optional If you are providing any equipment to the customer than you need to pass the equipment_id.
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.  
lifeline_enrollment_type String LIFELINE Required 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
is_ebb_qualify String Y Optional This is set as Y if ebb qualify. Y/N
is_tribal String Optional This is use for tribal.
school_name String Optional
school_district_name String Optional
nv_ebb_application_id String Optional This is the application ID which customer gets from national verifier when enrolling for the ACP service on national verifier website
coupon_code String Optional
coupon_transaction_id String Optional
topup_id array Optional This is the top-up/add-on which you need to add on the customer's account at the time of activation. This id is returned as plan_id in topup_list API
transfer_exception String TE1,TE2,TE3,TE4 Optional If the customer or applicant is tranferring his services within one month of activation from other MVNO than only you are required pass the transfer_exception.
acp_benefit_transfer_consent String Y or N Optional
acp_benefit_transfer_question_one String Y or N Optional if acp_benefit_transfer_consent =Y then there should be value acp_benefit_transfer_question_one= Y or acp_benefit_transfer_question_two=Y
household_parent String Optional
household_relative String Optional
household_roommate String Optional
school_name String Optional
device_benefit_already_reimbursed String Y or N Optional
is_sim_only_order String Y or N Optional If the order is only sim order than this field should be Y. If the order is tablet order than this field should be N. Expected values : Y or N
is_free_phone_order String Y or N Optional If you are providing the applicant a free phone than this field should be Y else N. Expected values : Y or N
is_hotspot_order String Y or N Optional If providing a hotspot to the applicant than this field should be Y else N. Expected values : Y or N
is_paid_phone_order String Y or N Optional If you are providing the customer a paid phone than this field should be Y else N. Expected values : Y or N
device_id String 105345443056123 Optional A device ID (device identification) is a distinctive number associated with a smartphone or similar handheld device. If you are giving the device to the customer than you need to pass the device_id. numeric only
sponsor_id alphanumeric fe3d9eb-8ba-4675-9df Optional This is the IBOID , used for tracking the order by the particular agent.
Sample Request REST
{  
   "enrollment_id":"WTX527537",
   "customer_suffix":"",
   "first_name":"ANTHONY",
   "middle_initial":"MICHAEL",
   "last_name":"BRADEN",
   "dob":"1988-11-19",
   "ssn":"2880",
   "driver_license_number":"122356565",
   "tribal_id":"",
   "beneficiary_suffix":"",
   "beneficiary_first_name":"ANTHONY",
   "beneficiary_middle_name":"MICHAEL",
   "beneficiary_last_name":"BRADEN",
   "beneficiary_dob":"1988-11-19",
   "beneficiary_ssn":"2880",
   "beneficiary_tribal_id":"",
   "best_way_to_reach":[  
      "email"
   ],
   "primary_telephone_number":"999999999",
   "email":"youremail@yourdomain.com",
   "alternative_contact_number":"",
   "alternative_email":"",
   "alternate_contact_name":"",
   "service_address_one":"37278 CHARLES ANDERSON RD",
   "service_address_two":"",
   "service_zip":"70452",
   "service_city":"PEARL RIVER",
   "service_state":"LA",
   "mailing_address_one":"",
   "mailing_address_two":"",
   "mailing_city":"",
   "mailing_state":"",
   "mailing_zip":"",
   "program_code":[  
      "SSI"
   ],
   "address_type":"P",
   "no_of_household":"",
   "is_household":"Y",
   "plan_id":"33",
   "household_adult":"Y",
   "household_share":"",
   "household_lifeline":"N",
   "enrollment_type":"SHIPMENT",
   "certify1":"",
   "certify2":"",
   "consent_check":"",
   "lifeline_enrollment_type":"EBB",
   "household_parent": "",
   "household_relative": "",
   "household_roommate": "",
   "school_name": "",
   "device_benefit_already_reimbursed": "",
   "is_sim_only_order": "Y",
   "is_free_phone_order": "N",
   "is_hotspot_order": "N",
   "is_paid_phone_order": "Y",
   "device_id": "",
   "sponsor_id":"",
   "action":"create_lifeline_customer",
   "agent_id":"ewebsiteapi",
   "source":"WEBSITE"
}
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":{  
      "enrollment_id":"WTX527537",
      "nladresponse":{  
         "data":"VERIFICATION_SUCCESS",
         "status":True
      }
   },
   "msg":"Success",
   "msg_code":"RESTAPI000",
   "token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.OTM0fQ.bG15ow1TqsA8-8yvk4blibP1XvIhUKAw1BJDOlNXEc0"
}
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.