nlad_verify_ebb Navigate to XML API

This REST API is used for nlad verify.

End Point https://www.vcareapi.com:8080/nlad
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
action String nlad_verify_ebb Required This needs to be passed as nlad_verify_ebb nlad_verify_ebb
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
source String API Required Source of the order/application Expected Value:API, TABLET, WEBSITE
agent_id String John Doe Required This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
acp_cert_ind String Y Required For this value can be pass Y or N.
If you not pass any value then will count as Y		 It's required value from Y or N
first_name String Robert Optional First name of subscriber. Accepts the SPACE character,
and these special characters:		 Alphabetic
last_name String Dee Optional Full, last name of subscriber. Minimum of two alphabetic characters. Alphabetic
middle_name String Optional Middle name of subscriber. Accepts the SPACE character,
and these special characters:		 Alphabetic
dob String 12/10/2021 Optional Subscriber's date of birth mm/dd/yyyy
ssn String Optional Last four digits of the subscriber's social security number. Numeric
tribal_id String 0000 Optional The Tribal identification number, or Tribal enrollment number of the subscriber. Providersthat have collected partial Tribal IDs may submit them so long as they have at least two characters. This field accepts some special characters, including (but not limited to) the dash character ( - ). Alphanumeric
beneficiary_first_name String Optional First name of the benefit qualifying person (BQP). Alphabetic
beneficiary_last_name String Optional Last name of the benefit qualifying person (BQP). Alphabetic
beneficiary_middle_name String Optional Middle name of the benefit qualifying person (BQP). Alphabetic
beneficiary_dob String 05/11/2000 Optional Date of birth of the benefit qualifying person (BQP). mm/dd/yyyy
beneficiary_ssn String Optional Last four digits of the BQP's social security number. Numeric
beneficiary_tribal_id String Optional Tribal identification number of the BQP. If the BQP does not have a Tribal ID or an SSN4, enter 0000” in the last4ssn field. Alphanumeric
address_one String Optional Subscriber's street address. Alphanumeric
address_two String Optional Subscriber's secondary address. Alphanumeric
city String Optional Subscriber's city of residence. Alphabetic
state String Optional Subscriber's state of residence. Alphabetic, Length: 2
zip_code String xxxxx or xxxxx-xxxx Optional Subscriber's ZIP code of residence. Accepts a dash
character ( - )		 Numeric
program_code String SNAP Optional These are returned in getProgramIncomeList REST API. If an applicant qualify on low income basis, you may pass empty tag and INCOMECERTIFY tag becomes Required. Multiple values example FPH::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
is_tribal String Y or N Optional Y or N Alphabetic
agent_password String JohnDoe 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.
school_name String Optional The name of the school where the consumer is approved for school lunch/breakfast or received Pell Grant award. Alphanumeric
email String test@mail.com Optional This is the email.
application_id String Optional This is the unique number of customer from National Verifier. Alphanumeric
transfer_exception String TE1,TE2,TE3,TE4 Optional it's for transfer exception if it's not null then expected values TE1,TE2,TE3,TE4 etc Alphanumeric
mailing_address_one String 1130 E INDEPENDENCE ST Optional Subscriber's mailing street address. Alphanumeric
mailing_address_two String APT 101 Optional Subscriber's secondary mailing address. Alphanumeric
mailing_city String SHAWNEE Optional Subscriber's mailing city. Alphabetic
mailing_state String OK Optional Subscriber's mailing state. Alphabetic, length: 2
mailing_zip String xxxxx or xxxxx-xxxx Optional Subscriber's mailing ZIP code.
Accepts a dash character ( - ).		 Numeric
contact_number String xxxxxxxxxx Optional The contact phone number of the subscriber. Numeric
Sample Request REST
{
    "enrollment_id": "EPCX7425",
    "first_name": "ASDFASDFASD",
    "middle_name": "",
    "last_name": "ASDFAS",
    "address_one": "1130 E INDEPENDENCE ST",
    "address_two": "APT 101",
    "city": "SHAWNEE",
    "state": "OK",
    "zip_code": "74804",
    "mailing_address_one": "",
    "mailing_address_two": "",
    "mailing_city": "",
    "mailing_state": "",
    "mailing_zip": null,
    "ssn": "4545",
    "dob": "1999-04-05",
    "tribal_id": null,
    "beneficiary_first_name": "ASDFASDFASD",
    "beneficiary_last_name": "ASDFAS",
    "beneficiary_dob": "1999-04-05",
    "beneficiary_ssn": "4545",
    "beneficiary_tribal_id": null,
    "program_code": [
        "SNAP"
    ],
    "no_of_household": "",
    "ebb_verify_type": "AVP",
    "school_name": "",
    "application_id": "",
    "contact_number": "",
    "email": "MITS@testemail.com",
    "action": "nlad_verify_ebb",
    "agent_id": "ewebsiteapi",
    "source": "ENROLLMENT_PORTAL"
}
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 passed all validations and verifications"
        }
    ],
    "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.