nlad_transfer_acp Navigate to XML API

We have introduced a new API nlad_transfer_acp API to handle the recent NLAD changes. Your current API flow would still work, however this new flow can be more effective. The new nlad_transfer_acp API allows us to transfer the customer to your SAC if customer is eligible for transfer.

End Point https://www.vcareapi.com:8080/nlad
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
address_one String 123 Main st Required (Required) The residence address of the subscriber (line 1 / street address). Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
address_two String APT 1 Optional (Optional) The residence address of the subscriber (line 2 / secondary address). Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
city String baltimore Required (Required) The city of residence of the subscriber. Minimum of 2 alphabetic characters. Accepts these special characters: space, hyphen (-).
state String MD Required
zip_code String 21215 Required
mailing_address_one String 123 Main st Required (Required) 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 Required (Optional) The mailing address of the subscriber (line 2 / secondary address). Accepts these special characters: space, forward slash (/), hash (#), hyphen (-).
mailing_city String baltimore Required (Required)The city of mailing of the subscriber. Minimum of 2 alphabetic characters. Accepts these special characters: space, hyphen (-).
mailing_state String MD Required
mailing_zip numeric 21215 Required
ssn numeric 1234 Required (Required) Last four digits of the social security number of the subscriber. Cannot contain '0000'.
dob String 1991-05-11 Required date (yyyy-mm-dd)
tribal_id String Optional
beneficiary_first_name String Optional
beneficiary_last_name String Optional
beneficiary_dob String 1991-05-11 Optional date (yyyy-mm-dd) (Conditional) Date of birth of the benefit-qualifying person (BQP).
beneficiary_ssn String 1245 Optional (Conditional) Last four digits of social security number of the benefit-qualifying person (BQP). Cannot contain '0000'.
beneficiary_tribal_id String Optional
program_code String SNAP Required "program_code": [
"SNAP"
],
no_of_household numeric 1 Optional
ebb_verify_type String NV Required should be NV
school_name String st mary's Optional (Conditional) only when program code is NSLP
contact_number String 2062091144 Optional
application_id String Optional
real_household String Y Optional Y or N or blank
acp_cert_ind String 1 Required 1 or 0. 1 if customer agreed for ACP services
email String john@company.com Optional
transfer_exception String 0 Required 0 or 1
action String nlad_transfer_acp Required nlad_transfer_acp
agent_id String devteamtg5 Required This is the user login id which will be created in Telgoo5 for the API user.
source String API Required Required. WEBSITE (if you are integrating these APIs on the website), API (if you are integrating these APIs in a CRM or BOT or any other APP
request_name String nlad Required
vendor_id String demo Required
device_benefit_already_reimbursed String Y Required (Required) Y if customer is not eligible for device, N if customer is eligible for device subsidy
device_id String 5678908976543432 Required (conditional) this is the default IMEI to send to NLAD if customer is eligible for the tablet
enrollment_id String EXC13454 Required (Required) It will be the same enrollment id which you go in the response for check_service_availability API
first_name String john Required (Required) The first name of the subscriber. Accepts these special characters: space, apostrophe (‘), accent Grave (`), hyphen (-). Minimum of 1 alphabetic character.
middle_name String d Optional (Optional) The middle name of the subscriber. Accepts these special characters: space, apostrophe (‘), accent Grave (`), hyphen (-). Minimum of 1 alphabetic character
last_name String doe Optional (Optional) The last name of the subscriber. Accepts these special characters: space, apostrophe (‘), accent grave (`), hyphen (-). Minimum of 2 alphabetic characters.
Sample Request REST
{
    "enrollment_id": "EXC13068",
    "first_name": "ATESFD",
    "middle_name": "",
    "last_name": "BTESFD",
    "address_one": "5726 CARMEL SAND ST",
    "address_two": "",
    "city": "NORTH LAS VEGAS",
    "state": "NV",
    "zip_code": "89031",
    "mailing_address_one": "5726 CARMEL SAND ST",
    "mailing_address_two": "",
    "mailing_city": "NORTH LAS VEGAS",
    "mailing_state": "NV",
    "mailing_zip": "89031",
    "ssn": "4976",
    "dob": "1994-01-11",
    "tribal_id": "",
    "beneficiary_first_name": "ATESFD",
    "beneficiary_last_name": "BTESFD",
    "beneficiary_dob": "1994-01-11",
    "beneficiary_ssn": "4976",
    "beneficiary_tribal_id": "",
    "program_code": [
        "SNAP"
    ],
    "no_of_household": "",
    "ebb_verify_type": "NV",
    "school_name": "",
    "contact_number": "7404545646",
    "application_id": "",
    "real_household": "Y",
    "acp_cert_ind": 1,
    "email": "TESOPS@VCAREMAIL.COM",
    "transfer_exception": "",
    "action": "nlad_transfer_acp",
    "agent_id": "Devteamqa",
    "source": "API",
    "request_name": "nlad",
    "vendor_id": "Dev-Exctelcom"
}
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":[{"message":"Subscriber successfully transferred","subscriberId":"","is_telgoo5_static":"Y"}],"msg_code":"RESTAPI000","msg":"Success"}
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.