---
# System prepended metadata

title: '**Authenticate API Document**'

---

# **Authenticate API Document**

- Authenticate Route is used create and validate your access token is valid or not. In General, getting access key and access token is not supported in this routes. What this does is only provided a way for you to validate if your current access token is a validate token or not. It's mainly purpose for development only.

## **Setting Up Your Access Key And Access Token**

- Setting up an access key and access token is pre-required to validate before you access the endpoint.

  1. In our high5 system platform setting page you will able to see a setup fields where will indicate how you can generate access key and access token.

  2. If your setting fields is being disable. Please contact customer support to ensure that
  you have right access for generating the access key and access token.

  3. Once you generate the access key and access token please store somewhere in your system.
  The access key and access token will not be revoked automatically unless you re-generated
  a new access key and access token.

## **Parameter in Authenticate Validation**

| Parameter             | Description                                                                                | Type         |
| --------              | --------                                                                                   | --------     |
| app_id(Required)      | App ID That Represent your Bot. Where you can find the information on system routes.       | string       |
| page_id(Required)     | Page ID That Represent your Bot. Where you can find the information on system routes.      | string       |
| app_type(Required)    | Type of your Bot. It can be either `line` or `messenger`.                                  | string       |


## **Method**

`GET /v1.0/authenticates/accesses/validates/apps/<app_id>/pages/<page_id>/types/<app_type>`

### **Success Response**

- **Code:** 200 <br />
  **Content** `{ status: "success"; message: "Validate Success"; }`;

### **Error Response**

- **Code:** 400 <br />
  **Content** `{ status: "error"; message: "App Id Missing" | "Page Id Missing" | "App Type Missing"; }`;

- **Code:** 422 <br />
  **Content** `{ status: "error"; message: "Invalid Token Or Access Key"; }`;

- **Code:** 500 <br />
  **Content** `{ status: "error"; message: "Internal Server Error"; }`;

### Example Request

```bash
curl --request GET '/v1.0/authenticates/accesses/validates/apps/730usiej/pages/1654886353/types/line?access_token=<access-token>'
```

