Authentication

Visualyze Document AI uses API Key authentication for accessing the services.

User Login

Used to get access token . Access token can be used to generate API keys.

POST URL:{{base_url}}/api/{{version}}/user/login

Request Body

Name	Type	Description
email*	multipart/formm-data	Email id of the user.
password*	multipart/formm-data	Password of the user.

400: Bad Request

{
    // Response
}

200: OK Response contains generated access token.

{
    "data": {
        "token": "string"
           },
    "message": "successfully generated access token",
    "status": 200
}

401: Unauthorized Invalid Credentials.

{
    "data": {},
    "message": "Invalid Credentials!",
    "status": 401
}

500: Internal Server Error

{
    // Response
}

Access token will expire in 1 hour.

User Logout

Used to revoke an access token.

POST URL:{{base_url}}/api/{{version}}/user/logout

Headers

Name	Type	Description
Authorization*	Bearer Token

200: OK Revoked access token.

{
    "data": {},
    "message": "Successfully logged out",
    "status": 200
}

401: Unauthorized Message field can be used to understand problem.

{
    "data": {},
    "message": "string",
    "status": 401
}

Generate API Key

Generate a new API Key for accessing the services.

GET URL:{{base_url}}/api/{{version}}/user/apikey/generate

To generate API key using access token.

Headers

Name	Type	Description
Authorization*	Bearer Token

200: OK Response contains the generated API key.

{     
"data": { 
            "api_key": "String"  
         },  
"message": "String", 
"status": 200 
}

400: Bad Request Message field can be used to identify the issue.

{
    "data": {},
    "message": "String",
    "status": 400
}

500: Internal Server Error

{
    // Response
}

401: Unauthorized

{
    // Response
}