customer_info Navigate to XML API

This REST API is used to get cutomer's information.

End Point https://www.vcareapi.com:8080/customer
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
get_security_question_answer_detail String Y Optional To get details of secret question and answer Expected values : Y / N
get_beneficiary_details String Y Optional This field is used to get the all information about the beneficiary.
If you want to know all the details about the beneficiary than you should pass Y in this field.		 Expected values : Y / N
action String customer_info Required This needs to be passed as customer_info. Expected value : customer_info
customer_id String 123456 Optional If you want to find the customer information through customer id than you can pass customer id. Auto generated customer account number
enrollment_id String EANG427 Required If you want to find the customer information through enrollment id than you can pass enrollment id. It will be the same enrollment id which you got in the response for check_service_availability API for that customer.
email String noreply@gmail.com Optional This is the email address of the customer. Valid Email address.
mdn String 1234567890 Optional This is the MDN which is attached to the subscriber's account Valid MDN.
last_name String Doe Optional This is the last name of the customer. Accepts these special characters: space, apostrophe (‘), accent grave (`), hyphen (-). Minimum of 2 alphabetic characters.
zip_code String 21215 Optional 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.
ssn_last_four String 2844 Optional If you want to find the customer information by his/her ssn than you can pass ssn last four digit here. Only numeric.
account_number String 2844 Optional To Search by account number Only numeric.
dob String 1996-02-20 Optional Date of birth of the customer. Expected format : YYYY-MM_DD
account_status String Active Optional Here you can pass the status of the account
get_pending_customer String Y Optional Expected values : Y or N.
get_parent_detail String Y Optional For get the parent information. Expected values : Y or N.
esn_number String Optional
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 John Doe 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.
source String API Required Source of the order/application Expected Value : API , WEBSITE
get_child_detail String Y Optional To get the child details if it's a combo order Expected values : Y / N
alternate_phone_number String 1234567895 Optional To search a customer by alternate number Valid alternate number.
get_enrollment_detail String Y Optional To get enrollment details. If not passed or N is passed then enrollment details will not come in response Expected values : Y / N
get_auth_user_detail String Y Optional To get details of authorized user Expected values : Y / N
enrollment_type String LIFELINE Optional To search a customer by enrollment type Expected values : LIFELINE / NON_LIFELINE
get_profile_picture String Y Optional To get profile picture Expected values : Y / N
show_device_info String Y Optional To get device id and name Expected values : Y / N
get_web_enrollment_plus_details String Y Optional To get web enrollment plus details Expected values : Y / N
get_web_enrollment_info_details String Y Optional To get additional web enrollment plus details Expected values : Y / N
get_nv_applicaiton_id String Y Optional To get application details Expected values : Y / N
get_insurance_detail String Y Optional To get insurance details Expected values : Y / N
get_bill_preference_detail String Y Optional To get bill preference details Expected values : Y / N
get_postpaid_upcoming_charges String Y Optional To get details of upcoming charges and limit Expected values : Y / N
get_donation_id String Y Optional To get details of donation Expected values : Y / N
get_customer_plus_details String Y Optional To get Customer Plus details Expected values : Y / N
get_collection_details String Y Optional To get details of postpaid collections Expected values : Y / N
get_bill_details String Y Optional To get details of postpaid invoices Expected values : Y / N
get_ssn String Y Optional To get SSN number of the customer. Expected values : Y / N
get_auth_user_ssn String Y Optional To get SSN number of authorized user Expected values : Y / N
get_loyalty_subscription_details String Y Optional To get details for Loyalty Subscription program Expected values : Y / N
sim String 1234567894561234567 Optional If you want to find the customer information by SIM / ESN than you can pass SIM/ESN here. Valid SIM/ESN.
imei String 789456123456789 Optional If you want to find the customer information by IMEI than you can pass IMEI here. Valid IMEI
Sample Request REST
 {
    "action": "customer_info",
    "enrollment_id": "",
    "email": "",
    "zip_code": "",
    "agent_id": "ewebsiteapi",
    "source": "WEBSITE",
    "mdn": "",
    "sim": "",
    "imei": "989867657766767 ",
    "customer_id": "",
    "get_parent_detail": "Y",
    "get_auth_user_detail": "",
    "get_child_detail": "",
    "get_loyalty_subscription_details": "Y"
}
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": [
        {
            "account_no": "100115",
            "account_password": "2626",
            "account_type": "GA",
            "account_type_name": "ACP",
            "acp_device_id": "",
            "alternate_mobile_no": "7678687686",
            "approved_date": "2023-02-01 06:27:47",
            "bill_to_customer": "0.00",
            "billing_city": "AUBURN",
            "billing_state": "WA",
            "billing_zip_code": "98001",
            "carrier": "TMB",
            "city": "AUBURN",
            "created_by": "Devteam",
            "created_datetime": "2023-02-01 07:58:46",
            "customer_id": "100115",
            "device_benefit_already_reimbursed": "0",
            "device_type": "PHONE",
            "discount_credit": "0.000",
            "dob": "1992-01-09",
            "e_sim_details": true,
            "ebb_device_type": "Tablet",
            "email_id": "TESOPS@VCAREMAIL.COM",
            "enrollment_id": "EANG195",
            "enrollment_type": "ACP",
            "esn_number": "989867657766767",
            "first_name": "AFFGDDGD",
            "initial_chosen_enroll_type": "ACP",
            "is_approved": "Y",
            "is_degraded_plan": "N",
            "is_ebb_qaulify": "1",
            "is_family_plan": "N",
            "is_free_phone_order": "0",
            "is_free_phone_order_paid": "0",
            "is_paid_phone_order": "0",
            "is_password_temporary": "N",
            "is_plan_data_unlimited": "N",
            "is_plan_sms_unlimited": "N",
            "is_plan_talk_unlimited": "N",
            "is_prepaid_postpaid": "prepaid",
            "is_sim_only_order": "0",
            "is_sim_phone_order": 0,
            "is_tablet_paid_phone_order": 0,
            "is_tablet_phone_order": 0,
            "is_tax_included": "",
            "is_unlimited_plan": "N",
            "ivr_pin": null,
            "kserial_no": "",
            "last_name": "BDGFDGDDG",
            "line_status": "Active",
            "mailing_address_one": "3792 E MAIN ST",
            "mailing_address_two": "",
            "mailing_city": "AUBURN",
            "mailing_state": "WA",
            "mailing_zip": "98001",
            "make_model": "apple iphone 6",
            "make_model_id": "3",
            "mdn": "9898776767",
            "middle_name": "",
            "model_device_type": "",
            "next_plan_change_renew_date": "",
            "next_plan_change_renew_type": "",
            "next_plan_expiry_date": "",
            "no_of_household": "0",
            "offer_type": "",
            "pin": null,
            "plan_code": "1",
            "plan_data": "5000MB",
            "plan_description": "5GB High Speed Mobile Internet Per Month",
            "plan_expiry_date": "2024-01-01",
            "plan_grace_expiry_date": "",
            "plan_id": "6",
            "plan_name": "5GB",
            "plan_sms": "0",
            "plan_start_date": "",
            "plan_talk": "0",
            "plan_total_price": "30",
            "preferred_language": "English",
            "program_code": [
                "MEDIC"
            ],
            "school_name": "",
            "service_address_one": "3792 E MAIN ST",
            "service_address_two": "",
            "service_city": "AUBURN",
            "service_state": "WA",
            "service_zip": "98001",
            "shipment_method": "AgentProgram",
            "state": "WA",
            "status": "Active",
            "tracking_code": "",
            "tribal_id": "GHGCBVCBV5646546",
            "wallet_balance": "0",
            "wfc_service_address_city": "",
            "wfc_service_address_one": "",
            "wfc_service_address_state": "",
            "wfc_service_address_two": "",
            "wfc_service_address_zip": "",
            "zip4": null,
            "zip_code": "98001"
        }
    ],
    "msg": "Success",
    "msg_code": "RESTAPI000",
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJuYW1lIjoiRGVtby1BbmdlbE1vYmlsZVVzZXIiLCJwYXNzd29yZCI6IkRlbW8tQW5nZWxNb2JteDlzcjV6cjg0NzUiLCJwaW4iOiJEZW1vLTg5MjM2OTI3Nzk3NyIsInZlbmRvcl9pZCI6IkRlbW8tQW5nZWxNb2JpbGUiLCJsb2dfaWQiOjY3NjM1NiwidXJsIjoiaHR0cHM6Ly9kZW1vLWFuZ2VsLnRlbGdvbzUuY29tL3ZjYXJlT3NzQXBpLyJ9LCJleHAiOjE3MDE5MDA5OTF9.jNEdSv_LXe3YBeVasmL8fgtClY-iZBZUrhNzpTFrWz4"
}
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.