Connect with app

Validates a security code provided by an assistant device and establishes a connection between a mobile app user and an assistant. The mobile app user’s token is passed in the body.

POST /connect

Error

A valid request URL is required to generate request examples

200

{
  "status": "success",
  "message": "Operation completed successfully",
  "assistant": {
    "id": 101,
    "name": "Cati Owner",
    "image": "http://example.com/image.jpg",
    "phone": "[phone]"
  }
}

Body

application/json

token · string · required

JWT Access Token of the mobile app user attempting to connect.

Example:

"eyJ..."

code · string · required

Security code obtained from the assistant device.

Example:

"AbC1dE2fG3"

Response

200

application/json

Connection successful. Returns assistant details.

status · string

Example:

"success"

message · string

Example:

"Operation completed successfully"

assistant · object

Show child attributes